Gửi tin nhắn preview link

Chúng tôi cung cấp một API gửi tin nhắn preview link, dưới định danh của người dùng hoặc bot.

HTTP request

POST https://{app_id}.api.piscale.com/open-api/v1.0/chat/messages

Request body

Ví dụ

{
    "sender": {
        // "bot_id": "6872016393689131",
        "user_id": "30043"
    },
    "target": {
        // "user_ids": ["30043"]
        "thread_id": "62046069159700"
    },
    "body": {
        "text": "Mọi người xem docs ở đây nè: https://docs.communi.io/docs/overview",
        "metadata": [
            {
                "sitename": "docs.communi.io",
                "description": "Communi Chat SDK cung cấp mọi thứ bạn cần để xây dựng trải nghiệm giao tiếp hấp dẫn trên ứng dụng của bạn, dành cho người dùng của bạn, theo cách mà bạn muốn",
                "source_url": "https://docs.communi.io/docs/overview",
                "source_thumb_url": "https://preview-image.piscale.com/https://docs.communi.io/img/sdk-social-card.png",
                "title": "Welcome to Communi Chat SDK | Communi Chat SDK",
                "type": "preview_link"
            }
        ]
    }
}

Tên	Kiểu dữ liệu	Mô tả	Bắt buộc
sender.bot_id	string	Gửi dưới định dạng bot	✗
sender.user_id	string	Gửi dưới định danh user	✗
target.user_ids	array	Danh sách các user_id nhận	✗
target.thread_id	string	Mã cuộc hội thoại	✗
body.text	string	Nội dung văn bản	✓
body.metadata	array	Danh sách hình ảnh	✓

note

• sender sẽ bắt buộc phải có bot_id hoặc user_id. Người gửi tin phải xác định rõ là một chương trình tự động (bot) hoặc là một người dùng.
• target sẽ bắt buộc phải có thread_id hoặc user_ids. user_ids tối đa 100 phần tử.

Giải thích các thuộc tính của metadata:

Tên	Kiểu dữ liệu	Mô tả	Bắt buộc
type	string	Phải là "preview_link"	✓
title	string	Tiêu đề	✓
sitename	string	Tên site	✓
description	string	Mô tả của site	✓
source_url	string	Đường dẫn liên kết	✓
source_thumb_url	string	Đường dẫn ảnh thumb	✓

Response

Nếu thành công, bạn sẽ nhận được phản hồi.

Ví dụ

{
    "message_code": "M200",
    "message": "Success"
}

Tên	Kiểu dữ liệu	Mô tả
message_code	string	Mã thông điệp. Xem chi tiết
message	string	Nội dung mã thông điệp